docs: use the dynamic README header endpoint - #500
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README header now uses a responsive, theme-aware image. It selects dark or light sources based on the user’s color scheme and includes accessible fallback text. ChangesREADME Header
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adopts the dynamic README header endpoint added in TanStack/tanstack.com#1076,
which is merged and live.
Every README banner in this repo now points a
<picture>athttps://tanstack.com/api/readme/instead of a committed PNG. The endpointrenders 1800x450 in light and dark, so a branding change lands in every README
at once and dark-mode readers get a dark banner.
What changed
<picture>, per GitHub's guidance. The trailing<img>stays the light variant, as the fallback for renderers that ignore<picture>(npm, most editors).clihad no banner at all - just a duplicated<h1>TanStack CLI</h1>. It now gets one, for parity with the other library repos.Verification
Every generated URL in this diff was requested against the live endpoint and
returned
200 image/pngat 1800x450.git grepconfirms no README stillreferences the old
media/header_*.pngpath.Heads up: deleting the committed PNG means npm pages for already-published
versions that embed the
raw.githubusercontent.com/.../main/media/header_*.pnglink will show a broken image, since that link is branch-pinned. New releases
pick up the endpoint URL.
Summary by CodeRabbit